IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/il_c/ilHwVisual.z/ilHwVisual

Text File | 2002-10-03 | 13.3 KB | 397 lines

iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



NNNNAAAAMMMMEEEE
     iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll - an X Visual

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/ilCdefs.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     The ilHwVisual object is filled in by the ilHwConnection::findVisual*
     methods. It provides an easy way to decode the attributes of an X Visual.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     XXXX aaaattttttttrrrriiiibbbbuuuutttteeee qqqquuuueeeerrrriiiieeeessss

          XVisualInfo* ilHwVisualGetVisualInfo(ilHwVisual *obj)
          GLXFBConfigSGIX ilHwVisualGetFBConfig(ilHwVisual *obj)
          Visual* ilHwVisualGetVisual(ilHwVisual *obj)
          int ilHwVisualGetClass(ilHwVisual *obj)
          VisualID ilHwVisualGetVisualID(ilHwVisual *obj)
          int ilHwVisualGetDepth(ilHwVisual *obj)
          int ilHwVisualGetColormapSize(ilHwVisual *obj)
          unsigned long ilHwVisualGetRedMask(ilHwVisual *obj)
          unsigned long ilHwVisualGetGreenMask(ilHwVisual *obj)
          unsigned long ilHwVisualGetBlueMask(ilHwVisual *obj)

     CCCCoooommmmppppoooonnnneeeennnntttt ssssiiiizzzzeeee qqqquuuueeeerrrriiiieeeessss

          int ilHwVisualGetComponentSize(ilHwVisual *obj)
          int ilHwVisualGetRedSize(ilHwVisual *obj)
          int ilHwVisualGetGreenSize(ilHwVisual *obj)
          int ilHwVisualGetBlueSize(ilHwVisual *obj)
          int ilHwVisualGetAlphaSize(ilHwVisual *obj)

     VVVViiiissssuuuuaaaallll ccccaaaappppaaaabbbbiiiilllliiiittttyyyy qqqquuuueeeerrrriiiieeeessss

          int ilHwVisualIsDoubleBuffer(ilHwVisual *obj)
          int ilHwVisualIsStereo(ilHwVisual *obj)
          int ilHwVisualIsRgb(ilHwVisual *obj)
          int ilHwVisualIsColorIndex(ilHwVisual *obj)
          int ilHwVisualDoesOpenGL(ilHwVisual *obj)
          int ilHwVisualHasDepth(ilHwVisual *obj)
          int ilHwVisualHasStencil(ilHwVisual *obj)
          int ilHwVisualHasAccum(ilHwVisual *obj)
          int ilHwVisualHasPbuffer(ilHwVisual *obj)
          int ilHwVisualHasAlpha(ilHwVisual *obj)
          int ilHwVisualGetVisualAttributes(ilHwVisual *obj)
          int ilHwVisualGetLevel(ilHwVisual *obj)

     MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss




                                                                        PPPPaaaaggggeeee 1111






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          iflColorModel ilHwVisualGetColorModel(ilHwVisual *obj)


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     ddddooooeeeessssOOOOppppeeeennnnGGGGLLLL(((())))

          int ilHwVisualDoesOpenGL(ilHwVisual *obj)


          This method returns true if the Visual supports OpenGL rendering.

     ggggeeeettttAAAAllllpppphhhhaaaaSSSSiiiizzzzeeee(((())))

          int ilHwVisualGetAlphaSize(ilHwVisual *obj)


          This method returns the alpha component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it will be zero since X doesn't support an alpha
          component.

     ggggeeeettttBBBBlllluuuueeeeMMMMaaaasssskkkk(((())))

          unsigned long ilHwVisualGetBlueMask(ilHwVisual *obj)


          This method returns the blue mask value from the XVisualInfo.

     ggggeeeettttBBBBlllluuuueeeeSSSSiiiizzzzeeee(((())))

          int ilHwVisualGetBlueSize(ilHwVisual *obj)


          This method returns the blue component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it is just derived from the visual depth and class.

     ggggeeeettttCCCCllllaaaassssssss(((())))

          int ilHwVisualGetClass(ilHwVisual *obj)


          This return the class of this Visual (e.g. TrueColor, PseudColor,
          etc.).

     ggggeeeettttCCCCoooolllloooorrrrmmmmaaaappppSSSSiiiizzzzeeee(((())))

          int ilHwVisualGetColormapSize(ilHwVisual *obj)







                                                                        PPPPaaaaggggeeee 2222






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          This method returns the colormap size from the XVisualInfo.

     ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))

          iflColorModel ilHwVisualGetColorModel(ilHwVisual *obj)


          This method returns the IL equivalent color model for this visual.

     ggggeeeettttCCCCoooommmmppppoooonnnneeeennnnttttSSSSiiiizzzzeeee(((())))

          int ilHwVisualGetComponentSize(ilHwVisual *obj)


          This method returns the component size of this Visual as seen by X.

     ggggeeeettttDDDDeeeepppptttthhhh(((())))

          int ilHwVisualGetDepth(ilHwVisual *obj)


          This method returns the depth of this visual.

     ggggeeeettttFFFFBBBBCCCCoooonnnnffffiiiigggg(((())))

          GLXFBConfigSGIX ilHwVisualGetFBConfig(ilHwVisual *obj)


          This method returns the FBConfig for this visual if there is one,
          NULL otherwise.

     ggggeeeettttGGGGrrrreeeeeeeennnnMMMMaaaasssskkkk(((())))

          unsigned long ilHwVisualGetGreenMask(ilHwVisual *obj)


          This method returns the green mask value from the XVisualInfo.

     ggggeeeettttGGGGrrrreeeeeeeennnnSSSSiiiizzzzeeee(((())))

          int ilHwVisualGetGreenSize(ilHwVisual *obj)


          This method returns the green component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it is just derived from the visual depth and class.

     ggggeeeettttLLLLeeeevvvveeeellll(((())))

          int ilHwVisualGetLevel(ilHwVisual *obj)





                                                                        PPPPaaaaggggeeee 3333






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          This method returns the level of this visual; zero indicates a
          normal visual, other values are for underlay and overlay visuals.

     ggggeeeettttRRRReeeeddddMMMMaaaasssskkkk(((())))

          unsigned long ilHwVisualGetRedMask(ilHwVisual *obj)


          This method returns the red mask value from the XVisualInfo.

     ggggeeeettttRRRReeeeddddSSSSiiiizzzzeeee(((())))

          int ilHwVisualGetRedSize(ilHwVisual *obj)


          This method returns the red component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it is just derived from the visual depth and class.

     ggggeeeettttVVVViiiissssuuuuaaaallll(((())))

          Visual* ilHwVisualGetVisual(ilHwVisual *obj)


          This method returns the X Visual* for this ilHwVisual.

     ggggeeeettttVVVViiiissssuuuuaaaallllAAAAttttttttrrrriiiibbbbuuuutttteeeessss(((())))

          int ilHwVisualGetVisualAttributes(ilHwVisual *obj)


          This method returns the 'ilHwVisualAttributes' attributes.  See
          <il/ilHwConnection.h> for a defintion of these attributes.

     ggggeeeettttVVVViiiissssuuuuaaaallllIIIIDDDD(((())))

          VisualID ilHwVisualGetVisualID(ilHwVisual *obj)


          This method returns the VisualID of this visual.

     ggggeeeettttVVVViiiissssuuuuaaaallllIIIInnnnffffoooo(((())))

          XVisualInfo* ilHwVisualGetVisualInfo(ilHwVisual *obj)


          This method returns the XVisualInfo* for this visual.

     hhhhaaaassssAAAAccccccccuuuummmm(((())))






                                                                        PPPPaaaaggggeeee 4444






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          int ilHwVisualHasAccum(ilHwVisual *obj)


          Returns TRUE if this visual has an accumumlation buffer.

     hhhhaaaassssAAAAllllpppphhhhaaaa(((())))

          int ilHwVisualHasAlpha(ilHwVisual *obj)


          Returns TRUE if this visual has an alpha component.

     hhhhaaaassssDDDDeeeepppptttthhhh(((())))

          int ilHwVisualHasDepth(ilHwVisual *obj)


          Returns TRUE if this visual has an depth buffer.

     hhhhaaaassssPPPPbbbbuuuuffffffffeeeerrrr(((())))

          int ilHwVisualHasPbuffer(ilHwVisual *obj)


          Returns TRUE if this visual is usable as a p-buffer.

     hhhhaaaassssSSSStttteeeennnncccciiiillll(((())))

          int ilHwVisualHasStencil(ilHwVisual *obj)


          Returns TRUE if this visual has stencil planes.

     iiiissssCCCCoooolllloooorrrrIIIInnnnddddeeeexxxx(((())))

          int ilHwVisualIsColorIndex(ilHwVisual *obj)


          This method returns true if this is a color-index visual.

     iiiissssDDDDoooouuuubbbblllleeeeBBBBuuuuffffffffeeeerrrr(((())))

          int ilHwVisualIsDoubleBuffer(ilHwVisual *obj)


          This method returns true if this is a double buffered visual.

     iiiissssRRRRggggbbbb(((())))

          int ilHwVisualIsRgb(ilHwVisual *obj)





                                                                        PPPPaaaaggggeeee 5555






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          This method returns true if this is a TrueColor or DirectColor
          visual.

     iiiissssSSSStttteeeerrrreeeeoooo(((())))

          int ilHwVisualIsStereo(ilHwVisual *obj)


          This method returns true if this is a stereo visual.











































                                                                        PPPPaaaaggggeeee 6666